battmon5 2.2.1
Loading...
Searching...
No Matches
battmon5.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2026 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
27
28#ifndef BATTMON5_H
29#define BATTMON5_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_i2c_master.h"
52
58
63
68
73#define BATTMON5_REG_BEFORE_RSOC 0x04
74#define BATTMON5_REG_TSENSE_THERM_B 0x06
75#define BATTMON5_REG_INITIAL_RSOC 0x07
76#define BATTMON5_REG_CELL_TEMP 0x08
77#define BATTMON5_REG_CELL_V 0x09
78#define BATTMON5_REG_CURRENT_DIR 0x0A
79#define BATTMON5_REG_APA 0x0B
80#define BATTMON5_REG_APT 0x0C
81#define BATTMON5_REG_RSOC 0x0D
82#define BATTMON5_REG_ITE 0x0F
83#define BATTMON5_REG_IC_VERSION 0x11
84#define BATTMON5_REG_CHANGE_PARAM 0x12
85#define BATTMON5_REG_ALARM_LOW_RSOC 0x13
86#define BATTMON5_REG_ALARM_LOW_CELL_V 0x14
87#define BATTMON5_REG_IC_POWER_MODE 0x15
88#define BATTMON5_REG_STATUS 0x16
89#define BATTMON5_REG_BATT_STATUS 0x19
90#define BATTMON5_REG_NUM_PARAM 0x1A
91#define BATTMON5_REG_TERM_CURRENT 0x1C
92#define BATTMON5_REG_EMPTY_CELL_V 0x1D
93#define BATTMON5_REG_ITE_OFFSET 0x1E
94 // battmon5_reg
96
101
106
111#define BATTMON5_APA_50MAH 0x1313
112#define BATTMON5_APA_100MAH 0x1515
113#define BATTMON5_APA_200MAH 0x1818
114#define BATTMON5_APA_500MAH 0x2121
115#define BATTMON5_APA_1000MAH 0x2D2D
116#define BATTMON5_APA_2000MAH 0x3A3A
117#define BATTMON5_APA_3000MAH 0x3F3F
118#define BATTMON5_APA_4000MAH 0x4242
119#define BATTMON5_APA_5000MAH 0x4444
120#define BATTMON5_APA_6000MAH 0x4545
121
126#define BATTMON5_CHANGE_PARAM_3_7_V 0x0000
127#define BATTMON5_CHANGE_PARAM_PANASONIC 0x0001
128#define BATTMON5_CHANGE_PARAM_SAMSUNG 0x0002
129#define BATTMON5_CHANGE_PARAM_3_8_V 0x0003
130#define BATTMON5_CHANGE_PARAM_3_85_V 0x0004
131
136#define BATTMON5_IC_POWER_MODE_NORMAL 0x0001
137#define BATTMON5_IC_POWER_MODE_SLEEP 0x0002
138
143#define BATTMON5_BATT_STATUS_CLEAR 0x0000
144#define BATTMON5_BATT_STATUS_LOW_CELL_V 0x0800
145#define BATTMON5_BATT_STATUS_LOW_RSOC 0x0200
146#define BATTMON5_BATT_STATUS_INIT 0x0080
147
153#define BATTMON5_DEVICE_ADDRESS 0x0B
154 // battmon5_set
156
161
166
171#define BATTMON5_MAP_MIKROBUS( cfg, mikrobus ) \
172 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
173 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
174 cfg.alarm = MIKROBUS( mikrobus, MIKROBUS_INT )
175 // battmon5_map // battmon5
178
183typedef struct
184{
185 // Input pins
186 digital_in_t alarm;
187
188 // Modules
189 i2c_master_t i2c;
190
191 // I2C slave address
193
194} battmon5_t;
195
200typedef struct
201{
202 pin_name_t scl;
203 pin_name_t sda;
204
205 pin_name_t alarm;
206
207 uint32_t i2c_speed;
208 uint8_t i2c_address;
209
211
216typedef enum
217{
220
222
228
239
254
268
282err_t battmon5_write_reg ( battmon5_t *ctx, uint8_t reg, uint16_t data_in );
283
297err_t battmon5_read_reg ( battmon5_t *ctx, uint8_t reg, uint16_t *data_out );
298
308
309#ifdef __cplusplus
310}
311#endif
312#endif // BATTMON5_H
313 // battmon5
315
316// ------------------------------------------------------------------------ END
battmon5_return_value_t
BATT-MON 5 Click return value data.
Definition battmon5.h:217
@ BATTMON5_ERROR
Definition battmon5.h:219
@ BATTMON5_OK
Definition battmon5.h:218
void battmon5_cfg_setup(battmon5_cfg_t *cfg)
BATT-MON 5 configuration object setup function.
err_t battmon5_write_reg(battmon5_t *ctx, uint8_t reg, uint16_t data_in)
BATT-MON 5 write reg function.
err_t battmon5_default_cfg(battmon5_t *ctx)
BATT-MON 5 default configuration function.
uint8_t battmon5_get_alarm_pin(battmon5_t *ctx)
BATT-MON 5 get alarm pin function.
err_t battmon5_init(battmon5_t *ctx, battmon5_cfg_t *cfg)
BATT-MON 5 initialization function.
err_t battmon5_read_reg(battmon5_t *ctx, uint8_t reg, uint16_t *data_out)
BATT-MON 5 read reg function.
BATT-MON 5 Click configuration object.
Definition battmon5.h:201
uint32_t i2c_speed
Definition battmon5.h:207
pin_name_t alarm
Definition battmon5.h:205
pin_name_t scl
Definition battmon5.h:202
pin_name_t sda
Definition battmon5.h:203
uint8_t i2c_address
Definition battmon5.h:208
BATT-MON 5 Click context object.
Definition battmon5.h:184
digital_in_t alarm
Definition battmon5.h:186
i2c_master_t i2c
Definition battmon5.h:189
uint8_t slave_address
Definition battmon5.h:192